Skip to content

Updated lychee and README#1262

Merged
VisLab merged 4 commits intohed-standard:mainfrom
VisLab:fix_extras
Mar 11, 2026
Merged

Updated lychee and README#1262
VisLab merged 4 commits intohed-standard:mainfrom
VisLab:fix_extras

Conversation

@VisLab
Copy link
Member

@VisLab VisLab commented Mar 11, 2026

No description provided.

@VisLab VisLab requested a review from Copilot March 11, 2026 10:37
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates link-checking configuration and documentation, plus bumps spec test submodules.

Changes:

  • Updated spec_tests submodule pointers for hed-tests and hed-schemas.
  • Adjusted Lychee configuration and GitHub Actions workflow to broaden link checking and add exclusions.
  • Added a Funding section to the README.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
spec_tests/hed-tests Updates submodule commit reference.
spec_tests/hed-schemas Updates submodule commit reference.
pyproject.toml Reformats Ruff exclude list string quoting.
lychee.toml Expands Lychee exclusions (local URLs + spec_tests paths).
README.md Adds project funding acknowledgment section.
.github/workflows/links.yaml Runs Lychee against built docs HTML plus key markdown files.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

@github-actions
Copy link

Review Summary

One important issue, one suggestion.

Important

lychee.toml: URL exclusion patterns placed in the wrong field (comment)

The patterns ^http://127\.0\.0\., ^http://localhost, ^https://localhost, and ^file:// were added to exclude_path. That field controls which files lychee scans, not which URLs lychee checks. URL skip-patterns belong in the exclude field. As written, localhost links inside README.md or the built docs will still be fetched and will likely fail CI.

Suggestion

README.md: missing trailing newline (comment)

The new Funding paragraph ends without a newline character. Minor POSIX issue that causes noisy diffs.


Everything else looks good: extending the lychee workflow to also check README.md, RELEASE_GUIDE.md, and CONTRIBUTING.md is a sensible improvement; the pyproject.toml quote-style normalisation is harmless; submodule bumps look routine.

@github-actions
Copy link

Review: Updated lychee and README

This PR cleanly replaces Black with ruff format and updates the link checker configuration. The mechanical changes (removing [tool.black], updating lychee.toml, updating docs/workflow descriptions) are correct and consistent. Three issues need attention before merge.

Important

  1. CLAUDE.md line-length still says 127 (line 71) — .rules/python.md was updated to 120 but CLAUDE.md was not. The enforced limit in pyproject.toml is 120. Developers following CLAUDE.md will configure their editors to the wrong width.

  2. Incomplete sentence in .rules/git.md (line 16) — the precommit bullet ends with "before to eliminate" with no object. Inline suggestion posted.

  3. Wrong CI workflow count (.rules/git.md line 38) — count jumps 12 → 13 but this PR removes black.yaml with no new workflow added; correct count is 11. Inline suggestion posted.

Suggestion

README.md line 185 has a pre-existing typo: "To iew the built documentation" → "To view". Worth fixing since nearby lines are already changed in this PR.

@github-actions
Copy link

PR Review: Clean migration from black/codespell to ruff-format/typos with consistent updates across CI, docs, and config. One suggestion posted as inline comment on lychee.toml (missing spec_tests/hed-specification in exclude_path for consistency with pyproject.toml ruff config). Otherwise LGTM.

@github-actions
Copy link

PR Review placeholder - will be replaced

@github-actions
Copy link

github-actions bot commented Mar 11, 2026

PR Review: Updated lychee and README. Clean tooling migration: black+codespell to ruff format+typos, pytest to python -m unittest discover, and lychee expanded to check README / RELEASE_GUIDE / CONTRIBUTING. Documentation updates throughout are consistent and correct. IMPORTANT - tests/ excluded from typos spell-checking (pyproject.toml line 128): The previous codespell config skipped spec_tests/ but not tests/. Excluding the entire tests/ directory removes spell-checking from test-file comments, docstrings, and assertion messages - spelling errors in those strings (e.g. error messages verified in assertIn calls) would go undetected. If the goal is to avoid false positives from Python identifiers or HED-specific strings, consider adding those terms to [tool.typos.default.extend-words] instead of silencing the whole directory. SUGGESTION - Stale comment in lychee.toml (line 35): the comment above exclude_path reads 'These are Sphinx theme template files with Jinja2 variables that should not be checked' but the block now also contains spec_tests/ submodule paths that have nothing to do with Sphinx templates. Everything else looks correct: the hed-specification submodule removal is handled consistently across .gitmodules, .gitignore, ruff excludes, and lychee paths; the typos extend-words whitelist mirrors the old codespell ignore list; and the 127 to 120 line-length documentation fix matches the pre-existing ruff line-length = 120 setting.

@VisLab VisLab merged commit 4806eda into hed-standard:main Mar 11, 2026
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants